Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update package, apply new readme style #3

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ptrcksc
Copy link

@ptrcksc ptrcksc commented Aug 21, 2024

  • add phpstan
  • add php-cs-fixer
  • run code-styling
  • format readme
  • update composer dependencies, add minimum php 8.1 check

@ptrcksc ptrcksc marked this pull request as draft August 21, 2024 14:14
@ptrcksc ptrcksc changed the title chore: Add php-cs-fixer and phpstan config, update dependencies chore: Update package, apply new readme style Aug 21, 2024
@ptrcksc ptrcksc requested a review from dnwjn August 21, 2024 14:24
@ptrcksc ptrcksc marked this pull request as ready for review August 21, 2024 14:25
@ptrcksc ptrcksc requested review from dnwjn and removed request for dnwjn August 27, 2024 13:16
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
## Installation
## Quick start

### Installation
Copy link
Member

@dnwjn dnwjn Sep 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be good to also indicate in the readme what the minimum requirements are? For example because the PHP version has now gone to 8.1?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PHP version is set in the composer.json file. I personally think this is clean enough, as a user I would expect this to follow Nova's minimum requirements, and PHP's supported versions.
Right now Nova is laravel8/PHP7.3, minimum supported PHP version is 8.1, so PHP 8.1?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You often see the versions in readme's. Even though a version is configured in composer.json and the package relies on Nova, it wouldn't hurt to put it in the readme, so anyone that wants to use the package can immediately see what the minimum requirements are.

README.md Show resolved Hide resolved
@dnwjn
Copy link
Member

dnwjn commented Sep 2, 2024

@ptrcksc One more thing I forgot: composer.lock should not be committed when it comes to packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants